Class: default

default()

Tool to reboot Wine

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.7.2

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.6.2

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.6.1

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.6

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Resource class

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install a sandbox

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.5.2

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2005

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.5

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install quartz

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install .NET 4.0

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2008

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install dotnet20sp2

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install msxml6

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2010

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install devenum

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Downloader class

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install msxml3

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2012

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install mspatcha

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install D3DX9

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install D3DX11

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install D3DX10

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Wine main prototype

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install d3drm

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install crypt32

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install corefonts

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install atmlib

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2013

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

setting to set the DirectDraw renderer

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to set the Fonts Smoothing

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to enable/disable GLSL

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to enable/disable UseTakeFocus

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

setting to set always offscreen

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to enable/disable Retina

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to configure mouse warp override

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to configure multisampling

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to set the offscreen rendering mode

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to set the render target lock mode

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to configure strict draw ordering

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Setting to set the video memory size

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install amstream

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install msls31.dll

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install adobeair

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2015

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install Windows XP Service Pack 3

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

WineShortcut prototype

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install mfc42.dll and mfc42u.dll

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install VK9

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2017

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install Uplay

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install luna

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install the Tahoma font

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun6sp6

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to remove mono

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install gdiplus

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install QuickTime 7.6

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Wine engine

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to configure Wine

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to kill running Wine processes

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install Nvidia PhysX

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to repair a Wine prefix

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to open the Wine registry editor

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to open the Wine task manager

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to open a terminal in a Wine prefix

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to uninstall Wine

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Tool to open a Wine console

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install vcrun2003

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install D9VK

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install all the necessary things to run winevulkan (even inside wine mainline or newest wine-staging)

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install DXVK

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install Gallium 9 Standalone

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install FAudio

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install xact

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource

default()

Verb to install secur32

Constructor

new default()

Source:

Methods

_createShortcut(prefixopt)

creates shortcut
Parameters:
Name Type Attributes Description
prefix string <optional>
prefix name
Source:

_fetchFileNameFromUrl(url) → {string}

Fetches the file name from an URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The file name
Type
string

algorithm(algorithm) → {Resource}

Sets the checksum algorithm
Parameters:
Name Type Description
algorithm string The algorithm to verify the checksum (e.g. "SHA")
Source:
Returns:
The Resource object
Type
Resource

algorithm(algorithm) → {Downloader}

Sets the algorithm which shall be used to verify the checksum
Parameters:
Name Type Description
algorithm string The checksum algorithm (e.g. "SHA")
Source:
Returns:
The Downloader object
Type
Downloader

application(application) → {AppResource}

Sets the application containing the resources
Parameters:
Name Type Description
application string The application with the resource
Source:
Returns:
The AppResource object
Type
AppResource

architecture() → {string}

Source:
Returns:
architecture ("x86" or "amd64")
Type
string

arguments(args) → {WineShortcut}

Sets the shortcut arguments
Parameters:
Name Type Description
args array The shortcut arguments
Source:
Returns:
The WineShortcut object
Type
WineShortcut

availableDistributions(architectureopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
architecture string <optional>
current architecture
Source:
Returns:
Type
Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:
Name Type Attributes Default Description
distribution name string <optional>
current distribution
Source:
Returns:
Type
Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used
Parameters:
Name Type Attributes Description
subCategory string <optional>
Wine sub-category
version string <optional>
Wine version
Source:
Returns:
path to "wine" binary
Type
string

category(category) → {WineShortcut}

Sets the shortcut category
Parameters:
Name Type Description
category string The shortcut category
Source:
Returns:
The WineShortcut object
Type
WineShortcut

checksum(checksum) → {Downloader}

Sets the checksum
Parameters:
Name Type Description
checksum string The checksum which shall be used to verify the download
Source:
Returns:
The Downloader object
Type
Downloader

checksum(checksum) → {Resource}

Sets the checksum which shall be used to verify the resource
Parameters:
Name Type Description
checksum string The checksum
Source:
Returns:
The Resource object
Type
Resource

create() → {Wine}

runs "wineboot"
Source:
Returns:
The Wine object
Type
Wine

create() → {void}

Creates a new shortcut
Source:
Returns:
Type
void

description(description) → {WineShortcut}

Sets the shortcut description
Parameters:
Name Type Description
description string The shortcut description
Source:
Returns:
The WineShortcut object
Type
WineShortcut

directory(directory) → {Resource}

Sets the directory inside the resources directory where the Resource is stored
Parameters:
Name Type Description
directory string The directory path
Source:
Returns:
The Resource object
Type
Resource

download(setupWizard) → {String}

Download the setup resources in the same directory, and returns the path of the .exe
Parameters:
Name Type Description
setupWizard SetupWizard The setup wizard
Source:
Returns:
The .exe file entry that can be used to continue the installation
Type
String

environment(environment) → {WineShortcut}

Sets the shortcut environment variables
Parameters:
Name Type Description
environment string The environment variables
Source:
Returns:
The WineShortcut object
Type
WineShortcut

environment(environment) → {QuickScript}

set environment
Parameters:
Name Type Description
environment string variables
Source:
Returns:
QuickScript object
Type
QuickScript

executable(executable, args)

set executable
Parameters:
Name Type Description
executable executable without path (e.g. "Steam.exe")
args use array (e.g. ["-applaunch", 409160])
Source:

fontDirectory() → {string}

Source:
Returns:
font directory
Type
string

get(resourceName) → {Resource}

Returns the searched resource
Parameters:
Name Type Description
resourceName string The name of the resource
Source:
Returns:
The found resource
Type
Resource

get() → {string}

Fetches the Resource and returns the path leading to the downloaded resource
Source:
Returns:
The path leading to the downloaded resource
Type
string

get() → {String}

Gets the content of the downloaded file
Source:
Returns:
The content of downloaded file
Type
String

getContainer() → {string}

Returns the name of the container belonging to a shortcut
Source:
Returns:
The container name
Type
string

gogSetupFileName(setupFileName) → {GogScript}

Sets one setup file name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileName string The setup file name
Source:
Returns:
This
Type
GogScript

gogSetupFileNames(setupFileNames) → {GogScript}

Sets the setup file(s) name so that the script can fetch it from gog.com
Parameters:
Name Type Description
setupFileNames Array.<string> The setup file name(s)
Source:
Returns:
This
Type
GogScript

headers(headers) → {Downloader}

Sets the http headers
Parameters:
Name Type Description
headers Object The http headers
Source:
Returns:
The Downloader object
Type
Downloader

json() → {any}

Gets the content of the downloaded file and returns it as a JSON value
Source:
Returns:
The json value
Type
any

kill() → {Wine}

kill wine server
Source:
Returns:
Type
Wine

loginToGog(setupWizard) → {GogScript}

Presents a Gog.com login window to the user, login to its account and return a token that can be used later. Stores the tocken in a parameter
Parameters:
Name Type Description
setupWizard SetupWizard The setupWizard to use
Source:
Returns:
This
Type
GogScript

message(message) → {Downloader}

Sets the download message text
Parameters:
Name Type Description
message string The download message
Source:
Returns:
The Downloader object
Type
Downloader

miniature(miniature) → {WineShortcut}

Sets the miniature for the shortcut
Parameters:
Name Type Description
miniature Array.<string> | URI An array which specifies the application of which the miniature shall be used or URI of the miniature
Source:
Returns:
The WineShortcut object
Type
WineShortcut

miniature(miniatureopt)

get/set miniature (for the installation and the shortcut)
Parameters:
Name Type Attributes Description
miniature URI <optional>
path to the miniature file
Source:

name(name) → {Resource}

Sets the resource name
Parameters:
Name Type Description
name string The name of the resource
Source:
Returns:
The Resource object
Type
Resource

name(name) → {WineShortcut}

Sets the shortcut name
Parameters:
Name Type Description
name string The shortcut name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

of(shortcut) → {void}

Sets shortcut
Parameters:
Name Type Description
shortcut string shortcut
Source:
Returns:
Type
void

onlyIfUpdateAvailable(onlyIfUpdateAvailable) → {Downloader}

Specifies if the download shall be executed only if a newer version is available
Parameters:
Name Type Description
onlyIfUpdateAvailable boolean true the download shall be executed only if a newer version is available
Source:
Returns:
The Downloader object
Type
Downloader

prefix(prefix) → {WineShortcut}

Sets the shortcut prefix
Parameters:
Name Type Description
prefix string The shortcut prefix
Source:
Returns:
The WineShortcut object
Type
WineShortcut

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:
Name Type Attributes Description
prefix string <optional>
distribution string <optional>
architecture string <optional>
version string <optional>
Source:
Returns:
Type
string | Wine

prefixDirectory() → {string}

returns prefix directory
Source:
Returns:
Type
string

programFiles() → {string}

Source:
Returns:
name of "Program Files"
Type
string

run(userArguments) → {void}

Runs a shortcut with the given user arguments
Parameters:
Name Type Description
userArguments array The user arguments
Source:
Returns:
Type
void

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
workingDirectory string <optional>
working container
captureOutput boolean <optional>
false
wait boolean <optional>
false
userData map <optional>
empty
Source:
Returns:
output
Type
String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:
Name Type Attributes Default Description
executable string
args array <optional>
[]
wait boolean <optional>
false
Source:
Sets the executable which shall be used
Parameters:
Name Type Description
search string The executable name
Source:
Returns:
The WineShortcut object
Type
WineShortcut

stop() → {void}

Stops the running shortcut
Source:
Returns:
Type
void

system32directory() → {string}

Source:
Returns:
system32 directory
Type
string

system64directory() → {string}

Source:
Returns:
system64 directory
Type
string

to(localDestination) → {Downloader}

Sets the download destination
Parameters:
Name Type Description
localDestination string The destination of the download. If it is a directory, the file will be placed inside
Source:
Returns:
The Downloader object
Type
Downloader

trustLevel(trustlevel) → {QuickScript}

set trust level
Parameters:
Name Type Description
trustlevel string
Source:
Returns:
QuickScript object
Type
QuickScript

trustLevel(trustLevel) → {WineShortcut}

Sets the trust level
Parameters:
Name Type Description
trustLevel string The trust level
Source:
Returns:
The WineShortcut object
Type
WineShortcut

type(type) → {WineShortcut}

Sets the shortcut type
Parameters:
Name Type Description
type string The shortcut type
Source:
Returns:
The WineShortcut object
Type
WineShortcut

uninstall() → {void}

Uninstalls the shortcut
Source:
Returns:
Type
void

uninstall(name) → {bool}

uninstall application
Parameters:
Name Type Description
name string of the application which shall be uninstalled
Source:
Returns:
true if an application has been uninstalled, false otherwise
Type
bool

url(url) → {Resource}

Sets the resource URL
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Resource object
Type
Resource

url(url) → {Downloader}

Sets the URL which shall be used for the download
Parameters:
Name Type Description
url string The URL
Source:
Returns:
The Downloader object
Type
Downloader

wait() → {Wine}

wait until wineserver finishes
Source:
Returns:
Type
Wine

winepath(pathopt) → {String}

Parameters:
Name Type Attributes Description
path String <optional>
Source:
Returns:
Type
String

wineServer(wineserver)

executes wineserver in current prefix
Parameters:
Name Type Description
wineserver string parameter
Source:

withScript(command) → {PlainInstaller}

Sets the installation script consisting of a lambda function
Parameters:
Name Type Description
command function The installation command
Source:
Returns:
The PlainInstaller object
Type
PlainInstaller

wizard(wizard) → {Downloader}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Downloader object
Type
Downloader

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:
Name Type Attributes Description
wizard SetupWizard <optional>
Source:
Returns:
Type
SetupWizard | Wine

wizard(wizard) → {Resource}

Sets the setup wizard
Parameters:
Name Type Description
wizard SetupWizard The setup wizard
Source:
Returns:
The Resource object
Type
Resource